POST /a/n/action/{Name}

Trigger an action on the tree. Returns a JobInfo describing a background task.

Body Parameters

Name	Description	Type	Required
AwaitStatus	Optionally wait for the task to exist with a specific status	#/definitions/jobsTaskStatus
AwaitTimeout	Define a golang duration to wait for	string
CopyMoveOptions		#/definitions/restActionOptionsCopyMove
DeleteOptions		#/definitions/restActionOptionsDelete
ExtractCompressOptions		#/definitions/restActionOptionsExtractCompress
JsonParameters	Should be deprecated in favor of ActionOptions	string
Nodes		array
SelectionUuid		string

Body Example

{
  "AwaitStatus": "string",
  "AwaitTimeout": "string",
  "CopyMoveOptions": {
    "TargetIsParent": true,
    "TargetPath": "string"
  },
  "DeleteOptions": {
    "PermanentDelete": true
  },
  "ExtractCompressOptions": {
    "ArchiveFormat": "string",
    "TargetPath": "string"
  },
  "JsonParameters": "string",
  "Nodes": [
    {
      "Path": "string",
      "Uuid": "string"
    }
  ],
  "SelectionUuid": "string"
}

Response Example (200)

Response Type /definitions/restPerformActionResponse

{
  "AffectedNodes": [
    {
      "Activities": [
        {
          "@context": "string",
          "accuracy": "[Unknown Type number]",
          "actor": "[Recursive structure]",
          "altitude": "[Unknown Type number]",
          "anyOf": "[Recursive structure]",
          "attachment": "[Recursive structure]",
          "attributedTo": "[Recursive structure]",
          "audience": "[Recursive structure]",
          "bcc": "[Recursive structure]",
          "bto": "[Recursive structure]",
          "cc": "[Recursive structure]",
          "closed": "string",
          "content": "[Recursive structure]",
          "current": "[Recursive structure]",
          "deleted": "string",
          "duration": "string",
          "endTime": "string",
          "first": "[Recursive structure]",
          "formerType": "string",
          "generator": "[Recursive structure]",
          "height": 10,
          "href": "string",
          "hreflang": "string",
          "icon": "[Recursive structure]",
          "id": "string",
          "image": "[Recursive structure]",
          "inReplyTo": "[Recursive structure]",
          "instrument": "[Recursive structure]",
          "items": [
            "[Recursive structure]"
          ],
          "last": "[Recursive structure]",
          "latitude": "[Unknown Type number]",
          "location": "[Recursive structure]",
          "longitude": "[Unknown Type number]",
          "markdown": "string",
          "mediaType": "string",
          "name": "string",
          "next": "[Recursive structure]",
          "object": "[Recursive structure]",
          "oneOf": "[Recursive structure]",
          "origin": "[Recursive structure]",
          "partOf": "[Recursive structure]",
          "prev": "[Recursive structure]",
          "preview": "[Recursive structure]",
          "published": "string",
          "radius": "[Unknown Type number]",
          "rel": "string",
          "relationship": "[Recursive structure]",
          "replies": "[Recursive structure]",
          "result": "[Recursive structure]",
          "startTime": "string",
          "subject": "[Recursive structure]",
          "summary": "string",
          "tag": "[Recursive structure]",
          "target": "[Recursive structure]",
          "to": "[Recursive structure]",
          "totalItems": 10,
          "type": "string",
          "units": "string",
          "updated": "string",
          "url": "[Recursive structure]",
          "width": 10
        }
      ],
      "ContentHash": "string",
      "ContentLock": {
        "IsLocked": true,
        "Owner": "string"
      },
      "ContentType": "string",
      "ContextWorkspace": {
        "Description": "string",
        "IsRoot": true,
        "IsVirtualRoot": true,
        "Label": "string",
        "Permissions": "string",
        "Quota": "string",
        "QuotaUsage": "string",
        "Scope": "string",
        "SkipRecycle": true,
        "Slug": "string",
        "Syncable": true,
        "Uuid": "string"
      },
      "DataSourceFeatures": {
        "Encrypted": true,
        "Versioned": true
      },
      "FolderMeta": [
        {
          "Namespace": "string",
          "Value": 10
        }
      ],
      "HashingMethod": "string",
      "ImageMeta": {
        "Height": 10,
        "JsonEXIF": "string",
        "Orientation": 10,
        "Width": 10
      },
      "IsBookmarked": true,
      "IsDraft": true,
      "IsRecycleBin": true,
      "IsRecycled": true,
      "Metadata": [
        {
          "Namespace": "string",
          "Value": "string"
        }
      ],
      "Mode": "string",
      "Modified": "string",
      "Path": "string",
      "PreSignedGET": {
        "ExpiresAt": "string",
        "Url": "string"
      },
      "Previews": [
        {
          "Bucket": "string",
          "ContentType": "string",
          "Dimension": 10,
          "Error": true,
          "Key": "string",
          "PreSignedGET": {
            "ExpiresAt": "string",
            "Url": "string"
          },
          "Processing": true
        }
      ],
      "Shares": [
        {
          "AccessEnd": "string",
          "AccessStart": "string",
          "CurrentDownloads": "string",
          "Description": "string",
          "Label": "string",
          "LinkHash": "string",
          "LinkUrl": "string",
          "MaxDownloads": "string",
          "PasswordRequired": true,
          "Permissions": [
            "string"
          ],
          "Policies": [
            {
              "Action": "string",
              "Effect": "string",
              "JsonConditions": "string",
              "Resource": "string",
              "Subject": "string",
              "id": "string"
            }
          ],
          "PoliciesContextEditable": true,
          "RestrictToTargetUsers": true,
          "RootNodes": [
            {
              "AppearsIn": [
                {
                  "Path": "string",
                  "WsLabel": "string",
                  "WsScope": "string",
                  "WsSlug": "string",
                  "WsUuid": "string"
                }
              ],
              "Commits": [
                {
                  "Data": "string",
                  "Description": "string",
                  "Event": {
                    "Metadata": {},
                    "Optimistic": true,
                    "Silent": true,
                    "Source": "[Recursive structure]",
                    "Target": "[Recursive structure]",
                    "Type": "string"
                  },
                  "Location": "[Recursive structure]",
                  "MTime": "string",
                  "OwnerUuid": "string",
                  "Size": "string",
                  "Uuid": "string"
                }
              ],
              "Etag": "string",
              "MTime": "string",
              "MetaStore": {},
              "Mode": 10,
              "ModeString": "string",
              "Path": "string",
              "Size": "string",
              "Type": "string",
              "Uuid": "string"
            }
          ],
          "TargetUsers": {},
          "UserLogin": "string",
          "UserUuid": "string",
          "Uuid": "string",
          "ViewTemplateName": "string"
        }
      ],
      "Size": "string",
      "StorageETag": "string",
      "Subscriptions": [
        {
          "Events": [
            "string"
          ],
          "ObjectId": "string",
          "ObjectType": "string",
          "UserId": "string"
        }
      ],
      "Type": "string",
      "UserMetadata": [
        {
          "Editable": true,
          "JsonValue": "string",
          "Namespace": "string",
          "NodeUuid": "string"
        }
      ],
      "Uuid": "string",
      "VersionMeta": {
        "Description": "string",
        "IsDraft": true,
        "IsHead": true,
        "OwnerUuid": "string",
        "VersionId": "string"
      },
      "Versions": [
        {
          "ContentHash": "string",
          "Description": "string",
          "Draft": true,
          "ETag": "string",
          "IsHead": true,
          "MTime": "string",
          "OwnerName": "string",
          "OwnerUuid": "string",
          "Size": "string",
          "VersionId": "string"
        }
      ]
    }
  ],
  "BackgroundActions": [
    {
      "CanPause": true,
      "CanStop": true,
      "EndTime": 10,
      "HasProgress": true,
      "JobUuid": "string",
      "Label": "string",
      "Name": "string",
      "Progress": "[Unknown Type number]",
      "StartTime": 10,
      "Status": "string",
      "StatusMessage": "string"
    }
  ],
  "Status": "string"
}